Skip to content

docs: add platforms overview index and custom evergreen setup guide - #11512

Open
AIdrifter wants to merge 1 commit into
youtube:mainfrom
AIdrifter:docs-platform-overview
Open

docs: add platforms overview index and custom evergreen setup guide#11512
AIdrifter wants to merge 1 commit into
youtube:mainfrom
AIdrifter:docs-platform-overview

Conversation

@AIdrifter

@AIdrifter AIdrifter commented Jul 23, 2026 •
edited
Loading

Copy link
Copy Markdown

Add a single centralized overview index (site/docs/development/index.md)

providing:

  • A comparison matrix of supported platforms (Linux, Android TV, RDK, Docker tooling).
  • A 3-stage recommended development workflow.
  • Custom Evergreen path configurations and parameter mapping reference table for SoC partners.
  • Step-by-step guide for SoC partners to build and compress custom debug Cobalt Core packages locally using host lz4_compress.

@github-actions

github-actions Bot commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

🤖 Gemini Suggested Commit Message

docs: Add development index and Evergreen guide

Add a centralized development overview index to improve the developer
onboarding experience. This includes a comparison matrix of supported
platforms, recommended workflows, and detailed configurations for
Evergreen path mapping. It specifically provides SoC partners with
instructions for building and compressing custom debug Cobalt Core
packages locally.

Bug: 537982944

💡 Pro Tips for a Better Commit Message:

  1. Influence the Result: Want to change the output? You can write custom prompts or instructions directly in the Pull Request description. The model uses that text to generate the message.
  2. Re-run the Generator: Post a comment with: /generate-commit-message

gemini-code-assist[bot]
gemini-code-assist Bot reviewed Jul 23, 2026
View reviewed changes

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces a new development and build platforms overview document (cobalt/site/docs/development/index.md) for Cobalt, detailing supported platforms, recommended workflows, and custom Evergreen setup instructions. Feedback was provided to correct the GN build target from cobalt_loader to cobalt lz4_compress to properly compile the Cobalt Core shared library and ensure the availability of the compression tool.

Comment thread cobalt/site/docs/development/index.md Outdated

2. **Compile Uncompressed Cobalt Core & Resources**:
```bash
autoninja -C out/<platform>_devel cobalt_loader

@gemini-code-assist gemini-code-assist Bot Jul 23, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The target cobalt_loader is incorrect. In Cobalt's Evergreen architecture, the target to compile the Cobalt Core shared library (libcobalt.so) and its resources is cobalt (or cobalt_install), whereas loader_app is the target for the loader executable itself. Since this step is intended to generate libcobalt.so and the resource files, the target should be updated to cobalt. Additionally, explicitly building the host tool lz4_compress ensures it is available for the optional compression step below.

Suggested change
autoninja -C out/<platform>_devel cobalt_loader
autoninja -C out/<platform>_devel cobalt lz4_compress

@AIdrifter
AIdrifter force-pushed the docs-platform-overview branch 6 times, most recently from 790c590 to d7ff4ae Compare July 28, 2026 06:31
@AIdrifter
docs: add platforms overview index and custom evergreen setup guide
4179b9a 
Add a single centralized overview index (site/docs/development/index.md)
providing:
- A comparison matrix of supported platforms (Linux, Android TV, RDK, Docker tooling).
- A 3-stage recommended development workflow.
- Custom Evergreen path configurations and parameter mapping reference table for SoC partners.
- Step-by-step guide for SoC partners to build and compress custom debug Cobalt Core packages locally using host lz4_compress.

Verified on:
- RDK reference hardware (Amlogic AH212 S905X4 STB): Built loader_app_rdk_plugin for Starboard API 18 (evergreen-arm-hardfp-rdk_qa), deployed 27.lts.1 (7.1.2) prebuilt CRX package to Slot 0 (app/cobalt/), verified AV1 video playback and runtime version 7.1.2.
- Linux x86 desktop: Verified loader_app with official 27.lts.1 prebuilt CRX package (Evergreen 7.1.2, sbversion-18).

Bug: 537982944
@AIdrifter
AIdrifter force-pushed the docs-platform-overview branch from d7ff4ae to 4179b9a Compare July 29, 2026 08:48
@AIdrifter

AIdrifter commented Jul 30, 2026

Copy link
Copy Markdown
Author

Hi @lamdbui
Hi @jonastsai

As our previous discussion.
Could you please review this PR?

Here is a quick summary of the changes:
1. Files Added/Modified:

  • Added a new centralized overview index at site/docs/development/index.md.
  • Included a comparison matrix of supported platforms (Linux, Android TV, RDK, Docker tooling).
  • Provided Custom Evergreen path configurations and a parameter mapping reference table for SoC partners.
  • Added a step-by-step guide for SoC partners to build and compress custom debug Cobalt Core packages locally.

2. Verification:
I have successfully verified the setup and deployment workflows on the following platforms:

  • RDK (Amlogic AH212 S905X4 STB): Deployed the prebuilt CRX package and successfully verified video playback.
  • Linux x86 desktop: Deployed the prebuilt CRX package and successfully verified video playback.

@AIdrifter
AIdrifter requested review from jonastsai and lamdbui July 30, 2026 07:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lamdbui lamdbui Awaiting requested review from lamdbui
@jonastsai jonastsai Awaiting requested review from jonastsai
1 more reviewer
@gemini-code-assist gemini-code-assist[bot] gemini-code-assist[bot] left review comments
Reviewers whose approvals may not affect merge requirements

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@AIdrifter